/*
 * Copyright (c) 2025 Huawei Device Co., Ltd.
 * Licensed under the Apache License, Version 2.0 (the "License"),
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * @addtogroup TeeTrusted
 * @{
 *
 * @brief TEE（Trusted Excution Environment）可信执行环境API。
 *
 * 提供安全能力API，例如可信存储、加解密及可信时间等，用于可信应用程序开发。
 *
 * @since 20
 */

/**
 * @file tee_hw_ext_api.h
 *
 * @brief 提供扩展接口。
 *
 * @library NA
 * @kit TEEKit
 * @include <TEEKit/tee_hw_ext_api.h>
 * @syscap SystemCapability.Tee.TeeClient
 * @since 20
 */

#ifndef TEE_HW_EXT_API_H
#define TEE_HW_EXT_API_H

#include "tee_defines.h"
#include "tee_crypto_api.h"

#ifdef __cplusplus
extern "C" {
#endif

/**
 * @brief 从TEE获取唯一设备ID。
 *
 * @param device_unique_id 指向用于存储设备ID的缓冲区的指针。
 * @param length 指向缓冲区长度的指针。
 *
 * @return TEE_SUCCESS：操作成功。\n
 *         返回其他信息，否则表示失败。
 * @since 20
 */
TEE_Result tee_ext_get_device_unique_id(uint8_t *device_unique_id, uint32_t *length);

/**
 * @brief 定义内存信息结构体。
 *
 * @since 20
 */
struct meminfo_t {
    /** 内存缓冲区地址。 */
    uint64_t buffer;
    /** 内存大小。 */
    uint32_t size;
};

/**
 * @brief 从设备根密钥和当前任务的UUID进行密钥派生迭代。
 *
 * @param salt [IN]指向盐值数据的指针。
 * @param key [OUT]指向保存派生密钥的指针。
 * @param outer_iter_num [IN]huk服务中的迭代次数。
 * @param inner_iter_num [IN]平台驱动中的迭代次数。
 *
 * @return TEE_SUCCESS：操作成功。\n
 *         TEE_ERROR_BAD_PARAMETERS：输入参数不正确。\n
 *         TEE_ERROR_GENERIC：处理失败。
 * @since 20
 */
TEE_Result tee_ext_derive_key_iter(const struct meminfo_t *salt, struct meminfo_t *key,
    uint32_t outer_iter_num, uint32_t inner_iter_num);

/**
 * @brief 使用HUK2加密算法，通过设备根密钥和当前任务的UUID迭代派生密钥。
 *
 * @param salt [IN]表示用于加盐的数据。
 * @param key [OUT]表示用于保存派生密钥的指针。
 * @param outer_iter_num [IN]表示在HUK服务中进行的迭代次数。
 * @param inner_iter_num [IN]表示在平台驱动中进行的迭代次数。
 *
 * @return TEE_SUCCESS：操作成功。\n
 *         TEE_ERROR_BAD_PARAMETERS：输入参数非法。\n
 *         TEE_ERROR_GENERIC：处理失败。
 * @since 20
 */
TEE_Result tee_ext_derive_key_iter_by_huk2(const struct meminfo_t *salt, struct meminfo_t *key,
    uint32_t outer_iter_num, uint32_t inner_iter_num);

/**
 * @brief 通过HUK2从设备根密钥派生密钥。
 * @attention 如果设备不支持HUK2，则使用HUK进行密钥派生。
 *
 * @param salt [IN]表示用于加盐的数据。
 * @param size [IN]表示盐的长度。
 * @param key [OUT]表示用于保存派生密钥的指针。
 * @param key_size [IN]表示密钥长度，必须为16的整数倍。
 *
 * @return TEE_SUCCESS：操作成功。\n
 *         TEE_ERROR_BAD_PARAMETERS：输入参数非法。\n
 *         TEE_ERROR_GENERIC：处理失败。
 *
 * @since 20
 */
TEE_Result tee_ext_derive_ta_root_key_by_huk2(const uint8_t *salt, uint32_t size, uint8_t *key, uint32_t key_size);

/**
 * @brief 使用增强型HUK2，通过设备根密钥和当前任务UUID进行迭代派生密钥。
 *
 * @param salt [IN]用于加盐的数据。
 * @param key [OUT]用于保存派生密钥的指针。
 * @param outer_iter_num [IN]表示在HUK服务中进行的迭代次数。
 * @param inner_iter_num [IN]表示在平台驱动中进行的迭代次数。
 *
 * @return TEE_SUCCESS：操作成功。\n
 *         TEE_ERROR_BAD_PARAMETERS：输入参数非法。\n
 *         TEE_ERROR_GENERIC：处理失败。
 *
 * @since 20
 */
TEE_Result tee_ext_derive_key_iter_by_huk2_enhance(const struct meminfo_t *salt, struct meminfo_t *key,
    uint32_t outer_iter_num, uint32_t inner_iter_num);

#ifdef __cplusplus
}
#endif

#endif
/** @} */